feat: Codegen config access modifier #2917

calvincestari · 2023-03-30T06:44:57Z

Introduces an accessModifier associated value to ApolloCodegenConfiguration properties where the generated Swift code can have the access level specified by the user.

Built with defaults that match the generated code before this PR
Built with optional decoding so that users can use their existing JSON configuration files without error

netlify · 2023-03-30T06:45:13Z

✅ Deploy Preview for apollo-ios-docs canceled.

Name	Link
🔨 Latest commit	`c14bdce`
🔍 Latest deploy log	https://app.netlify.com/sites/apollo-ios-docs/deploys/6462a5fb53144a0008a0b025

calvincestari · 2023-03-31T00:09:19Z

Sources/ApolloCodegenLib/ApolloCodegenConfiguration.swift

@@ -250,7 +255,7 @@ public struct ApolloCodegenConfiguration: Codable, Equatable {
      /// - Note: Generated files must be manually added to your application target. The generated
      /// schema types files will be namespaced with the value of your configuration's
      /// `schemaNamespace` to prevent naming conflicts.
-      case embeddedInTarget(name: String)
+      case embeddedInTarget(name: String, accessModifier: AccessModifier = .internal)


It might seem odd that the default is .internal but if you look at the tests that have changed there were tests that named xyz_withPublicModifier and xyz_noPublicModifier. withPublicModifier was used for the tests related to a .swiftPackageManager module type and noPublicModifier was used for tests related to .embeddedInTarget module type. Since we weren't specifying any access modifier all the generated code would have implicitly had internal access level.

The caveat to this is the namespace enum, which we used to always generate as public - that was an error though and not aligned with the rest of the generated code for a .embeddedInTarget module type.

calvincestari · 2023-03-31T00:13:56Z

Tests/ApolloCodegenTests/ApolloCodegenConfigurationCodableTests.swift

@@ -744,4 +746,57 @@ class ApolloCodegenConfigurationCodableTests: XCTestCase {
      try JSONDecoder().decode(ApolloCodegenConfiguration.APQConfig.self, from: subject)
    ).to(throwError())
  }
+
+  // MARK: - Optional Tests


I would like to add more tests for optional properties of the JSON decoding - will do in a follow-up PR. Unrelated to this work.

Tests/ApolloCodegenTests/CodeGeneration/Templates/InterfaceTemplateTests.swift

calvincestari · 2023-04-01T06:05:34Z

Fixing the inner access control modifiers was brutal.

Sources/ApolloCodegenLib/Templates/SelectionSetTemplate.swift

calvincestari · 2023-04-02T16:42:40Z

Putting this back into draft because there is a regression re. #2302.

…olute

Sources/ApolloCodegenLib/Templates/OperationDefinitionTemplate.swift

Sources/ApolloCodegenLib/Templates/TemplateRenderer.swift

Tests/TestCodeGenConfigurations/EmbeddedInTarget-RelativeAbsolute/PackageTwo/Package.swift

Sources/ApolloCodegenLib/Templates/TemplateRenderer.swift

Sources/ApolloCodegenLib/Templates/InputObjectTemplate.swift

lhunath · 2023-06-08T22:10:38Z

Please see #3066 for a regression likely related to this change.

calvincestari commented Mar 31, 2023

View reviewed changes

Tests/ApolloCodegenTests/CodeGeneration/Templates/InterfaceTemplateTests.swift Show resolved Hide resolved

calvincestari marked this pull request as ready for review March 31, 2023 00:23

calvincestari requested a review from AnthonyMDev March 31, 2023 00:24

calvincestari force-pushed the feature/codegen-access-modifier branch from e9e3a75 to 152236e Compare April 1, 2023 06:04

calvincestari commented Apr 1, 2023

View reviewed changes

Sources/ApolloCodegenLib/Templates/SelectionSetTemplate.swift Outdated Show resolved Hide resolved

calvincestari marked this pull request as draft April 2, 2023 16:42

calvincestari added 19 commits May 8, 2023 13:50

Add access level modifier to config

ff10113

Support config JSON serialization/deserialization

25c6d17

Refactor access level renderer

eeaa2b5

Add tests for TemplateRenderer access modifier

b474f3a

Update and add tests for access modifier

66817cf

Refactor mock templates to render with access control

df7ae86

Support optional decoding of TestMockFileOutput

220a9e8

Add accessModifier API documentation

728fd55

Update documentation for access modifier

829fff8

Fix inner entity access control (InputObjectTemplate)

2d6b42f

Fix inner entity access control (MockObjectTemplate)

de231e0

Fix inner entity access control (SchemaMetadataTemplate)

c03670d

Fix inner entity access control for operation-based templates

5ce4e95

Fix rebase mistake

888ea6b

Fix inner entity access level (LocalCacheMutationDefinitionTemplate)

05063a1

Fix inner entity access control (FragmentTemplate)

7f13ace

Resolve merge conflict build errors

6cc509a

Fix broken tests from merge conflict changes

b308763

Update new tests for config default access modifier output

0d8b920

calvincestari added 8 commits May 8, 2023 14:06

Fix rebase error

60b7b27

Add access modifier value to codegen config

63f5e25

Update codegen test projects config params

a46689d

Fix package and codegen configurations - EmbeddedInTarget-RelativeAbs…

c6ca2f0

…olute

Refactored access control modifier

c909e23

Removed test

c1f764c

Fixes statement alignment for wrapped lines

ce04c06

Fixes tests for access modifier refactor

b11ae45

calvincestari force-pushed the feature/codegen-access-modifier branch from 539512e to b11ae45 Compare May 12, 2023 23:16

calvincestari commented May 12, 2023

View reviewed changes

Sources/ApolloCodegenLib/Templates/OperationDefinitionTemplate.swift Show resolved Hide resolved

calvincestari commented May 13, 2023

View reviewed changes

Sources/ApolloCodegenLib/Templates/TemplateRenderer.swift Outdated Show resolved Hide resolved

calvincestari commented May 13, 2023

View reviewed changes

Tests/TestCodeGenConfigurations/EmbeddedInTarget-RelativeAbsolute/PackageTwo/Package.swift Show resolved Hide resolved

calvincestari commented May 13, 2023

View reviewed changes

Sources/ApolloCodegenLib/Templates/TemplateRenderer.swift Outdated Show resolved Hide resolved

calvincestari marked this pull request as ready for review May 13, 2023 00:16

Not needed

bd0e27d

calvincestari requested a review from BobaFetters May 13, 2023 01:58

This was referenced May 15, 2023

release: 1.1.4 #3013

Closed

release: 1.2 #3016

Merged

AnthonyMDev reviewed May 15, 2023

View reviewed changes

Sources/ApolloCodegenLib/Templates/TemplateRenderer.swift Outdated Show resolved Hide resolved

calvincestari commented May 15, 2023

View reviewed changes

Sources/ApolloCodegenLib/Templates/InputObjectTemplate.swift Outdated Show resolved Hide resolved

calvincestari added 3 commits May 15, 2023 14:24

Refactor function name

9732f06

Simplify TemplateRenderer extension function

9e99828

Renamed closure parameter name

c14bdce

calvincestari merged commit c4600ff into main May 15, 2023
17 checks passed

calvincestari deleted the feature/codegen-access-modifier branch May 15, 2023 21:57

lhunath mentioned this pull request Jun 8, 2023

Regression: accessModifier not honoured for custom scalars #3066

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Codegen config access modifier #2917

feat: Codegen config access modifier #2917

calvincestari commented Mar 30, 2023 •

edited

netlify bot commented Mar 30, 2023 •

edited

calvincestari Mar 31, 2023

calvincestari Mar 31, 2023 •

edited

calvincestari commented Apr 1, 2023

calvincestari commented Apr 2, 2023

lhunath commented Jun 8, 2023

feat: Codegen config access modifier #2917

feat: Codegen config access modifier #2917

Conversation

calvincestari commented Mar 30, 2023 • edited

netlify bot commented Mar 30, 2023 • edited

✅ Deploy Preview for apollo-ios-docs canceled.

calvincestari Mar 31, 2023

Choose a reason for hiding this comment

calvincestari Mar 31, 2023 • edited

Choose a reason for hiding this comment

calvincestari commented Apr 1, 2023

calvincestari commented Apr 2, 2023

lhunath commented Jun 8, 2023

calvincestari commented Mar 30, 2023 •

edited

netlify bot commented Mar 30, 2023 •

edited

calvincestari Mar 31, 2023 •

edited