Rename some properties and add atlassian sourcemap test

Author: sleeuwen

SourceMaps.Tests/Helper.cs

@@ -16,7 +16,7 @@ public static class Helper
             Names = new List<string> { "bar", "baz", "n" },
             Sources = new List<string> { "one.js", "two.js" },
             SourceRoot = "/the/root",
-            Mappings = "CAAC,IAAI,IAAM,SAAUA,GAClB,OAAOC,IAAID;CCDb,IAAI,IAAM,SAAUE,GAClB,OAAOA",
+            MappingsString = "CAAC,IAAI,IAAM,SAAUA,GAClB,OAAOC,IAAID;CCDb,IAAI,IAAM,SAAUE,GAClB,OAAOA",
         };
 
         public static readonly SourceMap TestMapNoSourceRoot = new SourceMap
@@ -25,7 +25,7 @@ public static class Helper
             File = "min.js",
             Names = new List<string> { "bar", "baz", "n" },
             Sources = new List<string> { "one.js", "two.js" },
-            Mappings =
+            MappingsString =
                 "CAAC,IAAI,IAAM,SAAUA,GAClB,OAAOC,IAAID;CCDb,IAAI,IAAM,SAAUE,GAClB,OAAOA"
         };
 
@@ -36,7 +36,7 @@ public static class Helper
             Names = new List<string> { "bar", "baz", "n" },
             Sources = new List<string> { "one.js", "two.js" },
             SourceRoot = "",
-            Mappings =
+            MappingsString =
                 "CAAC,IAAI,IAAM,SAAUA,GAClB,OAAOC,IAAID;CCDb,IAAI,IAAM,SAAUE,GAClB,OAAOA"
         };
 
@@ -47,7 +47,7 @@ public static class Helper
             Names = new List<string> { "bar", "baz" },
             Sources = new List<string> { "one.js" },
             SourceRoot = "",
-            Mappings = "CAAC,IAAI,IAAM,SAAUA,GAClB,OAAOC,IAAID"
+            MappingsString = "CAAC,IAAI,IAAM,SAAUA,GAClB,OAAOC,IAAID"
         };
 
         public static readonly SourceMap TestMapEmptyMappings = new SourceMap
@@ -58,7 +58,7 @@ public static class Helper
             Sources = new List<string> { "one.js", "two.js" },
             SourcesContent = new List<string> { " ONE.foo = 1;", " TWO.inc = 2;" },
             SourceRoot = "",
-            Mappings = ""
+            MappingsString = ""
         };
 
         public static readonly SourceMap TestMapEmptyMappingsRelativeSources = new SourceMap
@@ -69,7 +69,7 @@ public static class Helper
             Sources = new List<string> { "./one.js", "./two.js" },
             SourcesContent = new List<string> { " ONE.foo = 1;", " TWO.inc = 2;" },
             SourceRoot = "/the/root",
-            Mappings = ""
+            MappingsString = ""
         };
 
         public static readonly SourceMap TestMapEmptyMappingsRelativeSources_generatedExpected = new SourceMap
@@ -80,7 +80,7 @@ public static class Helper
             Sources = new List<string> { "one.js", "two.js" },
             SourcesContent = new List<string> { " ONE.foo = 1;", " TWO.inc = 2;" },
             SourceRoot = "/the/root",
-            Mappings = ""
+            MappingsString = ""
         };
 
         public static readonly SourceMap TestMapMultiSourcesMappingRefersSingleSourceOnly = new SourceMap
@@ -90,10 +90,9 @@ public static class Helper
             Names = new List<string> { "bar", "baz" },
             Sources = new List<string> { "one.js", "withoutMappings.js" },
             SourceRoot = "",
-            Mappings = "CAAC,IAAI,IAAM,SAAUA,GAClB,OAAOC,IAAID"
+            MappingsString = "CAAC,IAAI,IAAM,SAAUA,GAClB,OAAOC,IAAID"
         };
 
-
         public static readonly SourceMap TestMapWithSourcesContent = new SourceMap
         {
             Version = 3,
@@ -106,7 +105,7 @@ public static class Helper
                 " TWO.inc = function (n) {\n   return n + 1;\n };"
             },
             SourceRoot = "/the/root",
-            Mappings =
+            MappingsString =
                 "CAAC,IAAI,IAAM,SAAUA,GAClB,OAAOC,IAAID;CCDb,IAAI,IAAM,SAAUE,GAClB,OAAOA"
         };
 
@@ -122,7 +121,7 @@ public static class Helper
                 " TWO.inc = function (n) {\n   return n + 1;\n };"
             },
             SourceRoot = "/the/root",
-            Mappings =
+            MappingsString =
                 "CAAC,IAAI,IAAM,SAAUA,GAClB,OAAOC,IAAID;CCDb,IAAI,IAAM,SAAUE,GAClB,OAAOA"
         };
 
@@ -132,7 +131,7 @@ public static class Helper
             File = "min.js",
             Names = new List<string> { },
             Sources = new List<string> { },
-            Mappings = ""
+            MappingsString = ""
         };
 
         public static readonly SourceMap MapWithSourcelessMapping = new SourceMap
@@ -141,7 +140,7 @@ public static class Helper
             File = "example.js",
             Names = new List<string> { },
             Sources = new List<string> { "example.js" },
-            Mappings = "AAgCA,C"
+            MappingsString = "AAgCA,C"
         };
 
         public static void AssertMapping(
@@ -189,7 +188,7 @@ public static void AssertEqualMaps(SourceMap expected, SourceMap actual)
             }
 
             Assert.Equal(expected.SourceRoot, actual.SourceRoot);
-            Assert.Equal(expected.Mappings, actual.Mappings);
+            Assert.Equal(expected.MappingsString, actual.MappingsString);
 
             if (expected.SourcesContent != null)
             {

SourceMaps.Tests/SourceMapParserTests.cs

@@ -19,8 +19,8 @@ public void ApplyMappingSegment_CorrectlyUpdatesState()
             Assert.Equal(1, state.GeneratedLineNumber);
             Assert.Equal(6, state.GeneratedColumnNumber);
             Assert.Equal(3, state.SourcesListIndex);
-            Assert.Equal(4, state.OriginalSourceStartingLineNumber);
-            Assert.Equal(5, state.OriginalSourceStartingColumnNumber);
+            Assert.Equal(4, state.OriginalLineNumber);
+            Assert.Equal(5, state.OriginalColumnNumber);
             Assert.Equal(6, state.NamesListIndex);
 
             segmentFields = new List<int> { 1, 5, 4, 3 };
@@ -29,8 +29,8 @@ public void ApplyMappingSegment_CorrectlyUpdatesState()
             Assert.Equal(1, state.GeneratedLineNumber);
             Assert.Equal(7, state.GeneratedColumnNumber);
             Assert.Equal(8, state.SourcesListIndex);
-            Assert.Equal(8, state.OriginalSourceStartingLineNumber);
-            Assert.Equal(8, state.OriginalSourceStartingColumnNumber);
+            Assert.Equal(8, state.OriginalLineNumber);
+            Assert.Equal(8, state.OriginalColumnNumber);
             Assert.Equal(6, state.NamesListIndex);
 
             segmentFields = new List<int> { 1, 1, 1, 1, 3 };
@@ -39,15 +39,15 @@ public void ApplyMappingSegment_CorrectlyUpdatesState()
             Assert.Equal(1, state.GeneratedLineNumber);
             Assert.Equal(8, state.GeneratedColumnNumber);
             Assert.Equal(9, state.SourcesListIndex);
-            Assert.Equal(9, state.OriginalSourceStartingLineNumber);
-            Assert.Equal(9, state.OriginalSourceStartingColumnNumber);
+            Assert.Equal(9, state.OriginalLineNumber);
+            Assert.Equal(9, state.OriginalColumnNumber);
             Assert.Equal(9, state.NamesListIndex);
         }
 
         [Fact]
         public void ParseMappings_CorrectlyParsesSingleMapping()
         {
-            var result = SourceMapParser.ParseMappings(Helper.TestMapWithSourcesContent.Mappings, Helper.TestMapWithSourcesContent.Names, Helper.TestMapWithSourcesContent.Sources);
+            var result = SourceMapParser.ParseMappings(Helper.TestMapWithSourcesContent.MappingsString, Helper.TestMapWithSourcesContent.Names, Helper.TestMapWithSourcesContent.Sources);
 
             Assert.Equal(13, result.Count);
         }
@@ -105,7 +105,7 @@ public void Parse_MappingsAndEndOfLines()
         {
             var map = new SourceMap
             {
-                ParsedMappings = new List<SourceMapMappingEntry>
+                Mappings = new List<SourceMapMappingEntry>
                 {
                     new SourceMapMappingEntry(1, 1, 1, 1, null, "bar.js"),
                     new SourceMapMappingEntry(2, 2, 2, 2, null, "bar.js"),
@@ -131,7 +131,7 @@ public void Parse_OriginalPositionFor()
         {
             var map = new SourceMap
             {
-                ParsedMappings = new List<SourceMapMappingEntry>
+                Mappings = new List<SourceMapMappingEntry>
                 {
                     new SourceMapMappingEntry(2, 2, 1, 1, null,
                         "foo/bar/bang.coffee"),
@@ -145,6 +145,7 @@ public void Parse_OriginalPositionFor()
         }
 
         [Theory]
+        [InlineData("files/atlassian.sourcemap")]
         [InlineData("files/babel.sourcemap")]
         [InlineData("files/sass.sourcemap")]
         public void Parse_CanParseGeneratedSourcemaps(string path)

SourceMaps.Tests/files/atlassian.sourcemap

@@ -0,0 +1 @@
+{"version":3,"sources":["js/init.js"],"names":["define","ProjectIssueNavigator","Meta","WrmData","jQuery","init","element","projectIssueNavigator","el","canCreateIssues","claim","emptyViewContent","start","JIRA","API","getSidebar","done","Sidebar","AUISidebar","getAUISidebar","on","adjustSize","val","get","require","DarkFeatures","skate","REDIRECT_FROM_GLOBAL_TO_PROJECT","enabled","type","CLASSNAME","attached"],"mappings":"AAAAA,OAAO,mCACH,6BACA,sBACA,WACA,UACD,SACCC,EACAC,EACAC,EACAC,GAEA,YAEA,SAASC,GAAKC,GACV,GAAIC,GAAwB,GAAIN,IAC5BO,GAAIJ,EAAOE,GACXG,gBAAiBN,EAAQO,MAAM,sEAC/BC,iBAAkBR,EAAQO,MAAM,4EAEpCH,GAAsBK,QAEtBC,KAAKC,IAAIC,aAAaC,KAAK,SAAUC,GACjC,GAAIC,GAAaD,EAAQE,eAEzBD,GAAWE,GAAG,eAAgB,WAC1Bb,EAAsBc,eAG1BH,EAAWE,GAAG,aAAc,WACxBb,EAAsBc,iBAUlC,MALAjB,GAAO,WAEHA,EAAO,iDAAiDkB,IAAIpB,EAAKqB,IAAI,kBAGlElB,IAGXmB,SACI,oDACA,kCACA,aACA,UACD,SACCC,EACApB,EACAqB,EACAtB,GAEA,YAEA,KAAKqB,EAAaE,gCAAgCC,UAC9CxB,EAAO,WACHC,EAAKD,EAAO,oBAAoBmB,IAAI,UAGxCG,GAAM,wBACFG,KAAMH,EAAMG,KAAKC,UACjBC,SAAU,WACN1B,EAAKD,EAAO,oBAAoBmB,IAAI","file":"js/init-min.js","sourcesContent":["define('jira/projectissuenavigator/init', [\n    'jira/projectissuenavigator',\n    'jira/util/data/meta',\n    'wrm/data',\n    'jquery'\n], function(\n    ProjectIssueNavigator,\n    Meta,\n    WrmData,\n    jQuery\n) {\n    \"use strict\";\n\n    function init(element) {\n        var projectIssueNavigator = new ProjectIssueNavigator({\n            el: jQuery(element),\n            canCreateIssues: WrmData.claim(\"com.atlassian.jira.jira-projects-issue-navigator:can-create-issues\"),\n            emptyViewContent: WrmData.claim(\"com.atlassian.jira.jira-projects-issue-navigator:empty-state-panel-html\")\n        });\n        projectIssueNavigator.start();\n\n        JIRA.API.getSidebar().done(function (Sidebar) {\n            var AUISidebar = Sidebar.getAUISidebar();\n\n            AUISidebar.on('collapse-end', function () {\n                projectIssueNavigator.adjustSize();\n            });\n\n            AUISidebar.on('expand-end', function () {\n                projectIssueNavigator.adjustSize();\n            });\n        });\n    }\n\n    jQuery(function () {\n        // Horrible hack. This should go away during JDEV-31262\n        jQuery(\"fieldset.parameters input[title=loggedInUser]\").val(Meta.get(\"remote-user\"));\n    });\n\n    return init;\n});\n\nrequire([\n    'jira/components/issueviewer/services/darkfeatures',\n    'jira/projectissuenavigator/init',\n    'jira/skate',\n    'jquery'\n], function (\n    DarkFeatures,\n    init,\n    skate,\n    jQuery\n) {\n    \"use strict\";\n\n    if (!DarkFeatures.REDIRECT_FROM_GLOBAL_TO_PROJECT.enabled()) {\n        jQuery(function () {\n            init(jQuery('.issue-navigator').get(0));\n        });\n    } else {\n        skate('issue-navigator-init', {\n            type: skate.type.CLASSNAME,\n            attached: function () {\n                init(jQuery('.issue-navigator').get(0));\n            }\n        });\n    }\n});\n"],"sourceRoot":"/source/"}

SourceMaps/SourceMap.cs

@@ -3,7 +3,7 @@
 
 namespace SourceMaps
 {
-    public class SourceMap
+    public sealed class SourceMap
     {
         [JsonPropertyName("version")]
         public int Version { get; set; }
@@ -24,17 +24,24 @@ public class SourceMap
         public List<string> Names { get; set; }
 
         [JsonPropertyName("mappings")]
-        public string Mappings { get; set; }
+        public string MappingsString { get; set; }
 
         [JsonIgnore]
-        public List<SourceMapMappingEntry> ParsedMappings { get; set; }
+        public List<SourceMapMappingEntry> Mappings { get; set; }
 
+        /// <summary>
+        /// Returns the original source, line and column information for the generated
+        /// source's line and column positions provided.
+        /// </summary>
+        /// <param name="generatedLineNumber">The line number in the generated source, 1-based.</param>
+        /// <param name="generatedColumnNumber">The column number in the generated source, 0-based</param>
+        /// <returns>A struct with the original mappings, or null if no mapping exit for the given line and column number.</returns>
         public SourceMapMappingEntry? OriginalPositionFor(int generatedLineNumber, int generatedColumnNumber)
         {
-            if (ParsedMappings == null)
+            if (Mappings == null)
                 return null;
 
-            var index = ParsedMappings.BinarySearch(
+            var index = Mappings.BinarySearch(
                 new SourceMapMappingEntry(generatedLineNumber, generatedColumnNumber, null, null, null, null),
                 Comparer<SourceMapMappingEntry>.Create((a, b) =>
                 {
@@ -46,14 +53,14 @@ public class SourceMap
             if (index < 0)
             {
                 if (~index - 1 >= 0 &&
-                    ParsedMappings[~index - 1].GeneratedLineNumber == generatedLineNumber &&
-                    ParsedMappings[~index - 1].GeneratedColumnNumber == generatedColumnNumber)
+                    Mappings[~index - 1].GeneratedLineNumber == generatedLineNumber &&
+                    Mappings[~index - 1].GeneratedColumnNumber == generatedColumnNumber)
                 {
                     index = ~index - 1;
                 }
             }
 
-            return index >= 0 ? ParsedMappings[index] : (SourceMapMappingEntry?)null;
+            return index >= 0 ? Mappings[index] : (SourceMapMappingEntry?)null;
         }
     }
 }

SourceMaps/SourceMapMappingEntry.cs

@@ -2,15 +2,8 @@
 
 namespace SourceMaps
 {
-    public struct SourceMapMappingEntry : IEquatable<SourceMapMappingEntry>
+    public readonly struct SourceMapMappingEntry : IEquatable<SourceMapMappingEntry>
     {
-        public readonly int GeneratedLineNumber;
-        public readonly int GeneratedColumnNumber;
-        public readonly int? OriginalLineNumber;
-        public readonly int? OriginalColumnNumber;
-        public readonly string OriginalName;
-        public readonly string OriginalFileName;
-
         public SourceMapMappingEntry(int generatedLineNumber, int generatedColumnNumber, int? originalLineNumber, int? originalColumnNumber, string originalName, string originalFileName)
         {
             this.GeneratedLineNumber = generatedLineNumber;
@@ -21,6 +14,19 @@ public SourceMapMappingEntry(int generatedLineNumber, int generatedColumnNumber,
             this.OriginalFileName = originalFileName;
         }
 
+        public int GeneratedLineNumber { get; }
+        public int GeneratedColumnNumber { get; }
+        public int? OriginalLineNumber { get; }
+        public int? OriginalColumnNumber { get; }
+        public string OriginalName { get; }
+        public string OriginalFileName { get; }
+
+        public static bool operator ==(SourceMapMappingEntry left, SourceMapMappingEntry right)
+            => Equals(left, right);
+
+        public static bool operator !=(SourceMapMappingEntry left, SourceMapMappingEntry right)
+            => !Equals(left, right);
+
         public bool Equals(SourceMapMappingEntry other)
         {
             return GeneratedLineNumber == other.GeneratedLineNumber &&

SourceMaps/SourceMapParser.cs

@@ -11,9 +11,13 @@ public static class SourceMapParser
         public static SourceMap Parse(string sourceMapString)
         {
             var sourceMap = JsonSerializer.Deserialize<SourceMap>(sourceMapString);
+            if (sourceMap.Version != 3)
+                throw new ArgumentException($"Unknown source map version: {sourceMap.Version}");
+
             if (!string.IsNullOrEmpty(sourceMap.SourceRoot))
                 sourceMap.Sources = sourceMap.Sources.Select(source => Path.Combine(sourceMap.SourceRoot, source)).ToList();
-            sourceMap.ParsedMappings = ParseMappings(sourceMap.Mappings, sourceMap.Names, sourceMap.Sources);
+
+            sourceMap.Mappings = ParseMappings(sourceMap.MappingsString, sourceMap.Names, sourceMap.Sources);
             return sourceMap;
         }
 
@@ -41,23 +45,18 @@ internal static List<SourceMapMappingEntry> ParseMappings(string mappings, List<
 
         internal static void ApplyMappingSegment(List<int> segmentFields, ref MappingParserState state)
         {
-            if (segmentFields == null)
-            {
-                throw new ArgumentNullException(nameof(segmentFields));
-            }
+            _ = segmentFields ?? throw new ArgumentNullException(nameof(segmentFields));
 
-            if (segmentFields.Count == 0 || segmentFields.Count == 2 || segmentFields.Count == 3)
-            {
-                throw new ArgumentOutOfRangeException(nameof(segmentFields));
-            }
+            if (segmentFields.Count != 1 && segmentFields.Count != 4 && segmentFields.Count != 5)
+                throw new ArgumentOutOfRangeException(nameof(segmentFields), $"Expected 1, 4 or 5 fields, got {segmentFields.Count}");
 
             state.GeneratedColumnNumber += segmentFields[0];
 
             if (segmentFields.Count > 1)
             {
                 state.SourcesListIndex = (state.SourcesListIndex ?? 0) + segmentFields[1];
-                state.OriginalSourceStartingLineNumber = (state.OriginalSourceStartingLineNumber ?? 0) + segmentFields[2];
-                state.OriginalSourceStartingColumnNumber = (state.OriginalSourceStartingColumnNumber ?? 0) + segmentFields[3];
+                state.OriginalLineNumber = (state.OriginalLineNumber ?? 0) + segmentFields[2];
+                state.OriginalColumnNumber = (state.OriginalColumnNumber ?? 0) + segmentFields[3];
             }
 
             if (segmentFields.Count >= 5)
@@ -72,32 +71,32 @@ internal struct MappingParserState
         public int GeneratedLineNumber;
         public int GeneratedColumnNumber;
         public int? SourcesListIndex;
-        public int? OriginalSourceStartingLineNumber;
-        public int? OriginalSourceStartingColumnNumber;
+        public int? OriginalLineNumber;
+        public int? OriginalColumnNumber;
         public int? NamesListIndex;
 
         public MappingParserState(
             int generatedLineNumber,
             int generatedColumnNumber,
             int sourcesListIndex,
-            int originalSourceStartingLineNumber,
-            int originalSourceStartingColumnNumber,
+            int originalLineNumber,
+            int originalColumnNumber,
             int namesListIndex)
         {
             this.GeneratedLineNumber = generatedLineNumber;
             this.GeneratedColumnNumber = generatedColumnNumber;
+            this.OriginalLineNumber = originalLineNumber;
+            this.OriginalColumnNumber = originalColumnNumber;
             this.SourcesListIndex = sourcesListIndex;
-            this.OriginalSourceStartingLineNumber = originalSourceStartingLineNumber;
-            this.OriginalSourceStartingColumnNumber = originalSourceStartingColumnNumber;
             this.NamesListIndex = namesListIndex;
         }
 
         public SourceMapMappingEntry GetCurrentSourceMapMappingEntry(List<string> names, List<string> sources)
             => new SourceMapMappingEntry(
-                GeneratedLineNumber + 1,
-                GeneratedColumnNumber + 1,
-                OriginalSourceStartingLineNumber.HasValue ? OriginalSourceStartingLineNumber.Value + 1 : (int?)null,
-                OriginalSourceStartingColumnNumber.HasValue ? OriginalSourceStartingColumnNumber.Value + 1 : (int?)null,
+                GeneratedLineNumber,
+                GeneratedColumnNumber,
+                OriginalLineNumber,
+                OriginalColumnNumber,
                 NamesListIndex.HasValue ? names[NamesListIndex.Value] : null,
                 SourcesListIndex.HasValue ? sources[SourcesListIndex.Value] : null);
     }

SourceMaps/SourceMaps.csproj

@@ -2,6 +2,7 @@
 
     <PropertyGroup>
         <TargetFramework>netstandard2.0</TargetFramework>
+        <LangVersion>8.0</LangVersion>
     </PropertyGroup>
 
     <ItemGroup>