fix Custom Scalar should not be edited. output (#243)

apollographql · Jan 22, 2024 · ebccdfa · ebccdfa
1 parent 16c8e34
commit ebccdfa
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/Tests/ApolloCodegenTests/CodeGeneration/Templates/CustomScalarTemplateTests.swift b/Tests/ApolloCodegenTests/CodeGeneration/Templates/CustomScalarTemplateTests.swift
@@ -6,7 +6,8 @@ import ApolloAPI
 import GraphQLCompiler
 
 class CustomScalarTemplateTests: XCTestCase {
-  var subject: CustomScalarTemplate!
+  // Since the base protocol is actually used, Use TemplateRenderer. This can be confirmed that no unintended implementation is using.
+  var subject: TemplateRenderer!
 
   // MARK: Helpers
 
@@ -57,7 +58,21 @@ class CustomScalarTemplateTests: XCTestCase {
     // then
     expect(rendered).to(equalLineByLine(expected))
   }
+
+  // MARK: Header Tests
+
+  func test__contain_can_edited_header_description() throws {
+    // given
+    buildSubject()
+
+    // when
+    let rendered = subject.renderHeaderTemplate(nonFatalErrorRecorder: .init())
 
+    // then
+    expect(rendered?.description).toNot(contain("should not be edited"))
+    expect(rendered?.description).to(contain("can be edited"))
+  }
+
   // MARK: Typealias Definition Tests
 
   func test__render__givenCustomScalar_shouldGenerateStringTypealias() throws {

diff --git a/apollo-ios-codegen/Sources/ApolloCodegenLib/Templates/CustomScalarTemplate.swift b/apollo-ios-codegen/Sources/ApolloCodegenLib/Templates/CustomScalarTemplate.swift
@@ -14,7 +14,7 @@ struct CustomScalarTemplate: TemplateRenderer {
 
   func renderHeaderTemplate(
     nonFatalErrorRecorder: ApolloCodegen.NonFatalError.Recorder
-  ) -> TemplateString {
+  ) -> TemplateString? {
     HeaderCommentTemplate.editableFileHeader(
       fileCanBeEditedTo: "implement advanced custom scalar functionality."
     )