feat(create): fetch remote manifest after linking app during create #585
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Member
There was a problem hiding this comment. 🧪 todo: Let's add unit tests alongside internal packages for more strict checks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| // Copyright 2022-2026 Salesforce, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package manifest | ||
|
|
||
| import ( | ||
| "context" | ||
| "path/filepath" | ||
|
|
||
| "github.com/slackapi/slack-cli/internal/goutils" | ||
| "github.com/slackapi/slack-cli/internal/shared" | ||
| "github.com/spf13/afero" | ||
| ) | ||
|
|
||
| // SetManifestLocal fetches the app manifest from remote settings and writes it to the project. | ||
| func SetManifestLocal(ctx context.Context, clients *shared.ClientFactory, token, appID, projectPath string) error { | ||
| slackYaml, err := clients.AppClient().Manifest.GetManifestRemote(ctx, token, appID) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| manifestJSON, err := goutils.JSONMarshalUnescapedIndent(slackYaml.AppManifest) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| manifestPath := filepath.Join(projectPath, "manifest.json") | ||
| if err := afero.WriteFile(clients.Fs, manifestPath, []byte(manifestJSON), 0644); err != nil { | ||
| return err | ||
| } | ||
| hash, err := clients.Config.ProjectConfig.Cache().NewManifestHash(ctx, slackYaml.AppManifest) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return clients.Config.ProjectConfig.Cache().SetManifestHash(ctx, appID, hash) | ||
|
Comment on lines
+40
to
+44
Member
There was a problem hiding this comment. 🏆 praise: Thanks for including this! 🦔 thought: I'm now curious if this would be better as part of the |
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| // Copyright 2022-2026 Salesforce, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package manifest | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/slackapi/slack-cli/internal/app" | ||
| "github.com/slackapi/slack-cli/internal/cache" | ||
| "github.com/slackapi/slack-cli/internal/config" | ||
| "github.com/slackapi/slack-cli/internal/goutils" | ||
| "github.com/slackapi/slack-cli/internal/hooks" | ||
| "github.com/slackapi/slack-cli/internal/shared" | ||
| "github.com/slackapi/slack-cli/internal/shared/types" | ||
| "github.com/slackapi/slack-cli/internal/slackcontext" | ||
| "github.com/slackapi/slack-cli/internal/slackerror" | ||
| "github.com/spf13/afero" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/mock" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func Test_SetManifestLocal(t *testing.T) { | ||
| testManifest := types.SlackYaml{ | ||
| AppManifest: types.AppManifest{ | ||
| DisplayInformation: types.DisplayInformation{Name: "Test App"}, | ||
| }, | ||
| } | ||
|
|
||
| tests := map[string]struct { | ||
| setupMocks func(*shared.ClientsMock, *shared.ClientFactory) | ||
| expectError bool | ||
| assertFile bool | ||
| }{ | ||
| "writes manifest and saves hash on success": { | ||
| setupMocks: func(clientsMock *shared.ClientsMock, clients *shared.ClientFactory) { | ||
| manifestMock := &app.ManifestMockObject{} | ||
| manifestMock.On("GetManifestRemote", mock.Anything, "xoxp-token", "A001"). | ||
| Return(testManifest, nil) | ||
| clients.AppClient().Manifest = manifestMock | ||
|
|
||
| cc := cache.NewCacheMock() | ||
| cc.On("NewManifestHash", mock.Anything, testManifest.AppManifest). | ||
| Return(cache.Hash("abc123"), nil) | ||
| cc.On("SetManifestHash", mock.Anything, "A001", cache.Hash("abc123")). | ||
| Return(nil) | ||
|
|
||
| proj := config.NewProjectConfigMock() | ||
| proj.On("Cache").Return(cc) | ||
| clients.Config.ProjectConfig = proj | ||
| }, | ||
| expectError: false, | ||
| assertFile: true, | ||
| }, | ||
| "returns error when GetManifestRemote fails": { | ||
| setupMocks: func(clientsMock *shared.ClientsMock, clients *shared.ClientFactory) { | ||
| manifestMock := &app.ManifestMockObject{} | ||
| manifestMock.On("GetManifestRemote", mock.Anything, mock.Anything, mock.Anything). | ||
| Return(types.SlackYaml{}, slackerror.New("api error")) | ||
| clients.AppClient().Manifest = manifestMock | ||
| }, | ||
| expectError: true, | ||
| assertFile: false, | ||
| }, | ||
| "returns error when file write fails": { | ||
| setupMocks: func(clientsMock *shared.ClientsMock, clients *shared.ClientFactory) { | ||
| manifestMock := &app.ManifestMockObject{} | ||
| manifestMock.On("GetManifestRemote", mock.Anything, mock.Anything, mock.Anything). | ||
| Return(testManifest, nil) | ||
| clients.AppClient().Manifest = manifestMock | ||
|
|
||
| clients.Fs = afero.NewReadOnlyFs(&afero.MemMapFs{}) | ||
| }, | ||
| expectError: true, | ||
| assertFile: false, | ||
| }, | ||
| "returns error when SetManifestHash fails": { | ||
| setupMocks: func(clientsMock *shared.ClientsMock, clients *shared.ClientFactory) { | ||
| manifestMock := &app.ManifestMockObject{} | ||
| manifestMock.On("GetManifestRemote", mock.Anything, mock.Anything, mock.Anything). | ||
| Return(testManifest, nil) | ||
| clients.AppClient().Manifest = manifestMock | ||
|
|
||
| cc := cache.NewCacheMock() | ||
| cc.On("NewManifestHash", mock.Anything, mock.Anything). | ||
| Return(cache.Hash("abc123"), nil) | ||
| cc.On("SetManifestHash", mock.Anything, mock.Anything, mock.Anything). | ||
| Return(slackerror.New("cache write error")) | ||
|
|
||
| proj := config.NewProjectConfigMock() | ||
| proj.On("Cache").Return(cc) | ||
| clients.Config.ProjectConfig = proj | ||
| }, | ||
| expectError: true, | ||
| assertFile: true, | ||
| }, | ||
| } | ||
|
|
||
| for name, tc := range tests { | ||
| t.Run(name, func(t *testing.T) { | ||
| ctx := slackcontext.MockContext(t.Context()) | ||
| clientsMock := shared.NewClientsMock() | ||
| clientsMock.AddDefaultMocks() | ||
| clients := shared.NewClientFactory(clientsMock.MockClientFactory(), func(c *shared.ClientFactory) { | ||
| c.SDKConfig = hooks.NewSDKConfigMock() | ||
| }) | ||
|
|
||
| tc.setupMocks(clientsMock, clients) | ||
|
|
||
| err := SetManifestLocal(ctx, clients, "xoxp-token", "A001", "/project") | ||
|
|
||
| if tc.expectError { | ||
| assert.Error(t, err) | ||
| } else { | ||
| assert.NoError(t, err) | ||
| } | ||
|
|
||
| if tc.assertFile { | ||
| content, readErr := afero.ReadFile(clients.Fs, "/project/manifest.json") | ||
| require.NoError(t, readErr) | ||
|
|
||
| expected, _ := goutils.JSONMarshalUnescapedIndent(testManifest.AppManifest) | ||
| assert.Equal(t, expected, string(content)) | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
left a comment about this silent fail 🪂 #585 (comment) @zimeg
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@srtaalej I'm still hesitant to passthrough with an unexpected manifest. I'll leave a review comment but am curious if earlier thinking still stands?