feat: detect flag extinctions

README.md

@@ -101,6 +101,7 @@ This action does not support monorepos or searching for flags across LaunchDarkl
 | include-archived-flags | Scan for archived flags | `false` | true |
 | max-flags | Maximum number of flags to find per PR | `false` | 5 |
 | base-uri | The base URI for the LaunchDarkly server. Most users should use the default value. | `false` | https://app.launchdarkly.com |
+| check-extinctions | Check if removed flags still exist in codebase | `false` | true |
 <!-- action-docs-inputs -->
 
 <!-- action-docs-outputs -->
@@ -117,4 +118,7 @@ This action does not support monorepos or searching for flags across LaunchDarkl
 | any-changed | Returns true if any flags have been changed in PR |
 | changed-flags | Space-separated list of flags changed in PR |
 | changed-flags-count | Number of flags changed in PR |
+| any-extinct | Returns true if any flags have been removed in PR and no longer exist in codebase. Only returned if `check-extinctions` is true. |
+| extinct-flags | Space-separated list of flags removed in PR and no longer exist in codebase. Only returned if `check-extinctions` is true. |
+| extinct-flags-count | Number of flags removed in PR and no longer exist in codebase. Only returned if `check-extinctions` is true. |
 <!-- action-docs-outputs -->

action.yml

@@ -41,6 +41,10 @@ inputs:
     description: The base URI for the LaunchDarkly server. Most users should use the default value.
     required: false
     default: 'https://app.launchdarkly.com'
+  check-extinctions:
+    description: Check if removed flags still exist in codebase
+    required: false
+    default: 'true'
 
 outputs:
   any-modified:
@@ -61,3 +65,9 @@ outputs:
     description: Space-separated list of flags changed in PR
   changed-flags-count:
     description: Number of flags changed in PR
+  any-extinct:
+    description: Returns true if any flags have been removed in PR and no longer exist in codebase. Only returned if `check-extinctions` is true.
+  extinct-flags:
+    description: Space-separated list of flags removed in PR and no longer exist in codebase. Only returned if `check-extinctions` is true.
+  extinct-flags-count:
+    description: Number of flags removed in PR and no longer exist in codebase. Only returned if `check-extinctions` is true.

comments/comments.go

@@ -17,15 +17,15 @@ import (
 
 	"github.com/google/go-github/github"
 	ldapi "github.com/launchdarkly/api-client-go/v13"
-	"github.com/launchdarkly/find-code-references-in-pull-request/config"
 	lcr "github.com/launchdarkly/find-code-references-in-pull-request/config"
-	lflags "github.com/launchdarkly/find-code-references-in-pull-request/flags"
+	refs "github.com/launchdarkly/find-code-references-in-pull-request/internal/references"
 )
 
 type Comment struct {
 	Flag       ldapi.FeatureFlag
 	ArchivedAt time.Time
 	Added      bool
+	Extinct    bool
 	Aliases    []string
 	ChangeType string
 	Primary    ldapi.FeatureFlagConfig
@@ -37,10 +37,11 @@ func isNil(a interface{}) bool {
 	return a == nil || reflect.ValueOf(a).IsNil()
 }
 
-func githubFlagComment(flag ldapi.FeatureFlag, aliases []string, added bool, config *config.Config) (string, error) {
+func githubFlagComment(flag ldapi.FeatureFlag, aliases []string, added, extinct bool, config *lcr.Config) (string, error) {
 	commentTemplate := Comment{
 		Flag:       flag,
 		Added:      added,
+		Extinct:    config.CheckExtinctions && extinct,
 		Aliases:    aliases,
 		Primary:    flag.Environments[config.LdEnvironment],
 		LDInstance: config.LdInstance,
@@ -50,15 +51,13 @@ func githubFlagComment(flag ldapi.FeatureFlag, aliases []string, added bool, con
 		commentTemplate.ArchivedAt = time.UnixMilli(*flag.ArchivedDate)
 	}
 	// All whitespace for template is required to be there or it will not render properly nested.
-	tmplSetup := `| {{- if eq .Flag.Archived true}}{{- if eq .Added true}} :warning:{{- end}}{{- end}}` +
-		` [{{.Flag.Name}}]({{.LDInstance}}{{.Primary.Site.Href}})` +
-		`{{- if eq .Flag.Archived true}}` +
-		` (archived on {{.ArchivedAt | date "2006-01-02"}})` +
-		`{{- end}} | ` +
+	tmplSetup := `| [{{.Flag.Name}}]({{.LDInstance}}{{.Primary.Site.Href}}) | ` +
 		"`" + `{{.Flag.Key}}` + "` |" +
 		`{{- if ne (len .Aliases) 0}}` +
 		`{{range $i, $e := .Aliases }}` + `{{if $i}},{{end}}` + " `" + `{{$e}}` + "`" + `{{end}}` +
-		`{{- end}} |`
+		`{{- end}} | ` +
+		`{{- if eq .Extinct true}} :white_check_mark: all references removed{{- end}} ` +
+		`{{- if eq .Flag.Archived true}}{{- if eq .Extinct true}}<br>{{end}}{{- if eq .Added true}} :warning:{{else}} :information_source:{{- end}} archived on {{.ArchivedAt | date "2006-01-02"}}{{- end}} |`
 
 	tmpl := template.Must(template.New("comment").Funcs(template.FuncMap{"trim": strings.TrimSpace, "isNil": isNil}).Funcs(sprig.FuncMap()).Parse(tmplSetup))
 	err := tmpl.Execute(&commentBody, commentTemplate)
@@ -85,8 +84,8 @@ type FlagComments struct {
 	CommentsRemoved []string
 }
 
-func BuildFlagComment(buildComment FlagComments, flagsRef lflags.FlagsRef, existingComment *github.IssueComment) string {
-	tableHeader := "| Name | Key | Aliases found |\n| --- | --- | --- |"
+func BuildFlagComment(buildComment FlagComments, flagsRef refs.ReferenceSummary, existingComment *github.IssueComment) string {
+	tableHeader := "| Name | Key | Aliases found | Info |\n| --- | --- | --- | --- |"
 
 	var commentStr []string
 	commentStr = append(commentStr, "## LaunchDarkly flag references")
@@ -122,36 +121,32 @@ func BuildFlagComment(buildComment FlagComments, flagsRef lflags.FlagsRef, exist
 	return postedComments
 }
 
-func ProcessFlags(flagsRef lflags.FlagsRef, flags []ldapi.FeatureFlag, config *lcr.Config) FlagComments {
+func ProcessFlags(flagsRef refs.ReferenceSummary, flags []ldapi.FeatureFlag, config *lcr.Config) FlagComments {
 	buildComment := FlagComments{}
-	addedKeys := make([]string, 0, len(flagsRef.FlagsAdded))
-	for key := range flagsRef.FlagsAdded {
-		addedKeys = append(addedKeys, key)
-	}
-	// sort keys so hashing can work for checking if comment already exists
-	sort.Strings(addedKeys)
-	for _, flagKey := range addedKeys {
+
+	for _, flagKey := range flagsRef.AddedKeys() {
 		flagAliases := flagsRef.FlagsAdded[flagKey]
 		idx, _ := find(flags, flagKey)
-		createComment, err := githubFlagComment(flags[idx], flagAliases, true, config)
-		buildComment.CommentsAdded = append(buildComment.CommentsAdded, createComment)
+		createComment, err := githubFlagComment(flags[idx], flagAliases, true, false, config)
 		if err != nil {
 			log.Println(err)
 		}
+		buildComment.CommentsAdded = append(buildComment.CommentsAdded, createComment)
 	}
-	removedKeys := make([]string, 0, len(flagsRef.FlagsRemoved))
-	for key := range flagsRef.FlagsRemoved {
-		removedKeys = append(removedKeys, key)
-	}
-	sort.Strings(removedKeys)
-	for _, flagKey := range removedKeys {
+
+	for _, flagKey := range flagsRef.RemovedKeys() {
 		flagAliases := flagsRef.FlagsRemoved[flagKey]
 		idx, _ := find(flags, flagKey)
-		removedComment, err := githubFlagComment(flags[idx], flagAliases, false, config)
-		buildComment.CommentsRemoved = append(buildComment.CommentsRemoved, removedComment)
+		extinct := false
+		if flagsRef.ExtinctFlags != nil {
+			_, e := flagsRef.ExtinctFlags[flagKey]
+			extinct = e
+		}
+		removedComment, err := githubFlagComment(flags[idx], flagAliases, false, extinct, config)
 		if err != nil {
 			log.Println(err)
 		}
+		buildComment.CommentsRemoved = append(buildComment.CommentsRemoved, removedComment)
 	}
 
 	return buildComment
@@ -166,7 +161,7 @@ func find(slice []ldapi.FeatureFlag, val string) (int, bool) {
 	return -1, false
 }
 
-func uniqueFlagKeys(a, b lflags.FlagAliasMap) []string {
+func uniqueFlagKeys(a, b refs.FlagAliasMap) []string {
 	maxKeys := len(a) + len(b)
 	allKeys := make([]string, 0, maxKeys)
 	for k := range a {

comments/comments_test.go

@@ -6,7 +6,7 @@ import (
 
 	ldapi "github.com/launchdarkly/api-client-go/v13"
 	"github.com/launchdarkly/find-code-references-in-pull-request/config"
-	lflags "github.com/launchdarkly/find-code-references-in-pull-request/flags"
+	refs "github.com/launchdarkly/find-code-references-in-pull-request/internal/references"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -22,8 +22,9 @@ type testFlagEnv struct {
 func newTestAccEnv() *testFlagEnv {
 	flag := createFlag("example-flag")
 	config := config.Config{
-		LdEnvironment: "production",
-		LdInstance:    "https://example.com/",
+		LdEnvironment:    "production",
+		LdInstance:       "https://example.com/",
+		CheckExtinctions: true,
 	}
 
 	archivedFlag := createFlag("archived-flag")
@@ -61,17 +62,17 @@ func createFlag(key string) ldapi.FeatureFlag {
 
 type testCommentBuilder struct {
 	Comments FlagComments
-	FlagsRef lflags.FlagsRef
+	FlagsRef refs.ReferenceSummary
 }
 
 func newCommentBuilderAccEnv() *testCommentBuilder {
 	flagComments := FlagComments{
 		CommentsAdded:   []string{},
 		CommentsRemoved: []string{},
 	}
-	flagsAdded := make(lflags.FlagAliasMap)
-	flagsRemoved := make(lflags.FlagAliasMap)
-	flagsRef := lflags.FlagsRef{
+	flagsAdded := make(refs.FlagAliasMap)
+	flagsRemoved := make(refs.FlagAliasMap)
+	flagsRef := refs.ReferenceSummary{
 		FlagsAdded:   flagsAdded,
 		FlagsRemoved: flagsRemoved,
 	}
@@ -84,16 +85,16 @@ func newCommentBuilderAccEnv() *testCommentBuilder {
 
 type testProcessor struct {
 	Flags    []ldapi.FeatureFlag
-	FlagsRef lflags.FlagsRef
+	FlagsRef refs.ReferenceSummary
 	Config   config.Config
 }
 
 func newProcessFlagAccEnv() *testProcessor {
 	flag := createFlag("example-flag")
 	flags := []ldapi.FeatureFlag{flag}
-	flagsAdded := make(lflags.FlagAliasMap)
-	flagsRemoved := make(lflags.FlagAliasMap)
-	flagsRef := lflags.FlagsRef{
+	flagsAdded := make(refs.FlagAliasMap)
+	flagsRemoved := make(refs.FlagAliasMap)
+	flagsRef := refs.ReferenceSummary{
 		FlagsAdded:   flagsAdded,
 		FlagsRemoved: flagsRemoved,
 	}
@@ -113,9 +114,9 @@ func newProcessMultipleFlagsFlagAccEnv() *testProcessor {
 	flag := createFlag("example-flag")
 	flag2 := createFlag("second-flag")
 	flags := []ldapi.FeatureFlag{flag, flag2}
-	flagsAdded := make(lflags.FlagAliasMap)
-	flagsRemoved := make(lflags.FlagAliasMap)
-	flagsRef := lflags.FlagsRef{
+	flagsAdded := make(refs.FlagAliasMap)
+	flagsRemoved := make(refs.FlagAliasMap)
+	flagsRef := refs.ReferenceSummary{
 		FlagsAdded:   flagsAdded,
 		FlagsRemoved: flagsRemoved,
 	}
@@ -137,6 +138,8 @@ func TestGithubFlagComment(t *testing.T) {
 	t.Run("Flag with alias", acceptanceTestEnv.Alias)
 	t.Run("Archived flag added", acceptanceTestEnv.ArchivedAdded)
 	t.Run("Archived flag removed", acceptanceTestEnv.ArchivedRemoved)
+	t.Run("Extinct flag", acceptanceTestEnv.ExtinctFlag)
+	t.Run("Extinct and Archived flag", acceptanceTestEnv.ExtinctAndArchivedFlag)
 }
 
 func TestProcessFlags(t *testing.T) {
@@ -164,34 +167,50 @@ func TestBuildFlagComment(t *testing.T) {
 }
 
 func (e *testFlagEnv) NoAliases(t *testing.T) {
-	comment, err := githubFlagComment(e.Flag, []string{}, true, &e.Config)
+	comment, err := githubFlagComment(e.Flag, []string{}, true, false, &e.Config)
 	require.NoError(t, err)
 
-	expected := "| [example flag](https://example.com/test) | `example-flag` | |"
+	expected := "| [example flag](https://example.com/test) | `example-flag` | | |"
 	assert.Equal(t, expected, comment)
 }
 
 func (e *testFlagEnv) Alias(t *testing.T) {
-	comment, err := githubFlagComment(e.Flag, []string{"exampleFlag", "ExampleFlag"}, true, &e.Config)
+	comment, err := githubFlagComment(e.Flag, []string{"exampleFlag", "ExampleFlag"}, true, false, &e.Config)
 	require.NoError(t, err)
 
-	expected := "| [example flag](https://example.com/test) | `example-flag` | `exampleFlag`, `ExampleFlag` |"
+	expected := "| [example flag](https://example.com/test) | `example-flag` | `exampleFlag`, `ExampleFlag` | |"
 	assert.Equal(t, expected, comment)
 }
 
 func (e *testFlagEnv) ArchivedAdded(t *testing.T) {
-	comment, err := githubFlagComment(e.ArchivedFlag, []string{}, true, &e.Config)
+	comment, err := githubFlagComment(e.ArchivedFlag, []string{}, true, false, &e.Config)
 	require.NoError(t, err)
 
-	expected := "| :warning: [archived flag](https://example.com/test) (archived on 2023-08-03) | `archived-flag` | |"
+	expected := "| [archived flag](https://example.com/test) | `archived-flag` | | :warning: archived on 2023-08-03 |"
 	assert.Equal(t, expected, comment)
 }
 
 func (e *testFlagEnv) ArchivedRemoved(t *testing.T) {
-	comment, err := githubFlagComment(e.ArchivedFlag, []string{}, false, &e.Config)
+	comment, err := githubFlagComment(e.ArchivedFlag, []string{}, false, false, &e.Config)
+	require.NoError(t, err)
+
+	expected := "| [archived flag](https://example.com/test) | `archived-flag` | | :information_source: archived on 2023-08-03 |"
+	assert.Equal(t, expected, comment)
+}
+
+func (e *testFlagEnv) ExtinctFlag(t *testing.T) {
+	comment, err := githubFlagComment(e.Flag, []string{}, false, true, &e.Config)
+	require.NoError(t, err)
+
+	expected := "| [example flag](https://example.com/test) | `example-flag` | | :white_check_mark: all references removed |"
+	assert.Equal(t, expected, comment)
+}
+
+func (e *testFlagEnv) ExtinctAndArchivedFlag(t *testing.T) {
+	comment, err := githubFlagComment(e.ArchivedFlag, []string{}, false, true, &e.Config)
 	require.NoError(t, err)
 
-	expected := "| [archived flag](https://example.com/test) (archived on 2023-08-03) | `archived-flag` | |"
+	expected := "| [archived flag](https://example.com/test) | `archived-flag` | | :white_check_mark: all references removed<br> :information_source: archived on 2023-08-03 |"
 	assert.Equal(t, expected, comment)
 }
 
@@ -200,7 +219,7 @@ func (e *testCommentBuilder) AddedOnly(t *testing.T) {
 	e.Comments.CommentsAdded = []string{"comment1", "comment2"}
 	comment := BuildFlagComment(e.Comments, e.FlagsRef, nil)
 
-	expected := "## LaunchDarkly flag references\n### :mag: 1 flag added or modified\n\n| Name | Key | Aliases found |\n| --- | --- | --- |\ncomment1\ncomment2\n\n\n <!-- flags:example-flag -->\n <!-- comment hash: c449ce18623b2038f1ae2f02c46869cd -->"
+	expected := "## LaunchDarkly flag references\n### :mag: 1 flag added or modified\n\n| Name | Key | Aliases found | Info |\n| --- | --- | --- | --- |\ncomment1\ncomment2\n\n\n <!-- flags:example-flag -->\n <!-- comment hash: 58e2fd003e576dfd9e59d82b7fb20ca4 -->"
 	assert.Equal(t, expected, comment)
 }
 
@@ -210,7 +229,7 @@ func (e *testCommentBuilder) RemovedOnly(t *testing.T) {
 	e.Comments.CommentsRemoved = []string{"comment1", "comment2"}
 	comment := BuildFlagComment(e.Comments, e.FlagsRef, nil)
 
-	expected := "## LaunchDarkly flag references\n### :x: 2 flags removed\n\n| Name | Key | Aliases found |\n| --- | --- | --- |\ncomment1\ncomment2\n <!-- flags:example-flag,sample-flag -->\n <!-- comment hash: 9ab2cb5c0fcfcce9002cf0935f5f4ad5 -->"
+	expected := "## LaunchDarkly flag references\n### :x: 2 flags removed\n\n| Name | Key | Aliases found | Info |\n| --- | --- | --- | --- |\ncomment1\ncomment2\n <!-- flags:example-flag,sample-flag -->\n <!-- comment hash: acdd50c762ddfa84720067a3b272a032 -->"
 	assert.Equal(t, expected, comment)
 }
 
@@ -221,7 +240,7 @@ func (e *testCommentBuilder) AddedAndRemoved(t *testing.T) {
 	e.Comments.CommentsRemoved = []string{"comment1", "comment2"}
 	comment := BuildFlagComment(e.Comments, e.FlagsRef, nil)
 
-	expected := "## LaunchDarkly flag references\n### :mag: 1 flag added or modified\n\n| Name | Key | Aliases found |\n| --- | --- | --- |\ncomment1\ncomment2\n\n\n### :x: 1 flag removed\n\n| Name | Key | Aliases found |\n| --- | --- | --- |\ncomment1\ncomment2\n <!-- flags:example-flag -->\n <!-- comment hash: 7e6314b3b27a97ed6f8979304650af54 -->"
+	expected := "## LaunchDarkly flag references\n### :mag: 1 flag added or modified\n\n| Name | Key | Aliases found | Info |\n| --- | --- | --- | --- |\ncomment1\ncomment2\n\n\n### :x: 1 flag removed\n\n| Name | Key | Aliases found | Info |\n| --- | --- | --- | --- |\ncomment1\ncomment2\n <!-- flags:example-flag -->\n <!-- comment hash: 4f891355662b901597e6563a11c15332 -->"
 
 	assert.Equal(t, expected, comment)
 
@@ -231,7 +250,7 @@ func (e *testProcessor) Basic(t *testing.T) {
 	e.FlagsRef.FlagsAdded["example-flag"] = []string{}
 	processor := ProcessFlags(e.FlagsRef, e.Flags, &e.Config)
 	expected := FlagComments{
-		CommentsAdded: []string{"| [example flag](https://example.com/test) | `example-flag` | |"},
+		CommentsAdded: []string{"| [example flag](https://example.com/test) | `example-flag` | | |"},
 	}
 	assert.Equal(t, expected, processor)
 }
@@ -242,8 +261,8 @@ func (e *testProcessor) Multi(t *testing.T) {
 	processor := ProcessFlags(e.FlagsRef, e.Flags, &e.Config)
 	expected := FlagComments{
 		CommentsAdded: []string{
-			"| [example flag](https://example.com/test) | `example-flag` | |",
-			"| [second flag](https://example.com/test) | `second-flag` | |",
+			"| [example flag](https://example.com/test) | `example-flag` | | |",
+			"| [second flag](https://example.com/test) | `second-flag` | | |",
 		},
 	}
 	assert.Equal(t, expected, processor)

config/config.go

@@ -24,6 +24,7 @@ type Config struct {
 	MaxFlags             int
 	PlaceholderComment   bool
 	IncludeArchivedFlags bool
+	CheckExtinctions     bool
 }
 
 func ValidateInputandParse(ctx context.Context) (*Config, error) {
@@ -35,8 +36,13 @@ func ValidateInputandParse(ctx context.Context) (*Config, error) {
 		fmt.Printf("::add-mask::%s\n", repoToken)
 	}
 
-	// set config
-	var config Config
+	// init config with defaults
+	config := Config{
+		MaxFlags:             5,
+		IncludeArchivedFlags: true,
+		CheckExtinctions:     true,
+	}
+
 	config.LdProject = os.Getenv("INPUT_PROJECT-KEY")
 	if config.LdProject == "" {
 		return nil, errors.New("`project-key` is required")
@@ -74,12 +80,16 @@ func ValidateInputandParse(ctx context.Context) (*Config, error) {
 		config.PlaceholderComment = placholderComment
 	}
 
-	config.IncludeArchivedFlags = true
 	if includeArchivedFlags, err := strconv.ParseBool(os.Getenv("INPUT_INCLUDE-ARCHIVED-FLAGS")); err == nil {
 		// ignore error - default is true
 		config.IncludeArchivedFlags = includeArchivedFlags
 	}
 
+	if checkExtinctions, err := strconv.ParseBool(os.Getenv("INPUT_CHECK-EXTINCTIONS")); err == nil {
+		// ignore error - default is true
+		config.CheckExtinctions = checkExtinctions
+	}
+
 	config.GHClient = getGithubClient(ctx)
 	return &config, nil
 }